Portal Android SDK/io.portalhq.android.api.data.yieldxyz

Package-level declarations

Types

YieldXyzActionExecutionPattern

enum YieldXyzActionExecutionPattern : Enum<YieldXyzActionExecutionPattern>

Yield action execution patterns

YieldXyzActionIntent

enum YieldXyzActionIntent : Enum<YieldXyzActionIntent>

Yield action intent types

YieldXyzActionStatus

enum YieldXyzActionStatus : Enum<YieldXyzActionStatus>

Yield action status

YieldXyzActionTransaction

data class YieldXyzActionTransaction(val id: String, val title: String, val network: String, val status: YieldXyzActionTransactionStatus, val type: YieldXyzActionTransactionType, val hash: String? = null, val createdAt: String, val broadcastedAt: String? = null, val signedTransaction: String? = null, val unsignedTransaction: String? = null, val annotatedTransaction: Map<String, Any>? = null, val structuredTransaction: Map<String, Any>? = null, val stepIndex: Int, val description: String? = null, val error: String? = null, val gasEstimate: String? = null, val explorerUrl: String? = null, val isMessage: Boolean? = null)

Yield action transaction

YieldXyzActionTransactionStatus

enum YieldXyzActionTransactionStatus : Enum<YieldXyzActionTransactionStatus>

Yield action transaction status

YieldXyzActionTransactionType

enum YieldXyzActionTransactionType : Enum<YieldXyzActionTransactionType>

Yield action transaction type

YieldXyzActionType

enum YieldXyzActionType : Enum<YieldXyzActionType>

Yield action types

YieldXyzArgument

data class YieldXyzArgument(val fields: List<YieldXyzArgumentField>, val notes: String? = null)

Argument definition

YieldXyzArgumentField

data class YieldXyzArgumentField(val name: YieldXyzArgumentFieldName, val type: YieldXyzArgumentFieldType, val label: String, val description: String? = null, val required: Boolean? = null, val options: List<String>? = null, val optionsRef: String? = null, val default: Map<String, Any>? = null, val placeholder: String? = null, val minimum: String? = null, val maximum: String? = null, val isArray: Boolean? = null)

Argument field definition

YieldXyzArgumentFieldName

enum YieldXyzArgumentFieldName : Enum<YieldXyzArgumentFieldName>

Argument field name enum

YieldXyzArgumentFieldType

enum YieldXyzArgumentFieldType : Enum<YieldXyzArgumentFieldType>

Argument field type enum

YieldXyzArguments

data class YieldXyzArguments(val enter: YieldXyzArgument, val exit: YieldXyzArgument, val manage: Map<String, Any>? = null, val balance: YieldXyzArgument? = null)

Arguments for yield operations

YieldXyzBalance

data class YieldXyzBalance(val address: String, val amount: String, val amountRaw: String, val type: String, val token: YieldXyzBalanceToken, val pendingActions: List<YieldXyzBalancePendingAction> = emptyList(), val amountUsd: String? = null, val isEarning: Boolean? = null)

YieldXyzBalancePendingAction

data class YieldXyzBalancePendingAction(val intent: YieldXyzActionIntent, val type: YieldXyzActionType, val passthrough: String, val arguments: YieldXyzArgument? = null)

YieldXyzBalanceQuery

data class YieldXyzBalanceQuery(val address: String, val network: String, val yieldId: String? = null)

YieldXyzBalanceToken

data class YieldXyzBalanceToken(val address: String, val symbol: String, val name: String, val decimals: Int, val logoURI: String? = null, val network: String, val isPoints: Boolean? = null)

YieldXyzCooldownPeriod

data class YieldXyzCooldownPeriod(val seconds: Long)

Cooldown period information

YieldXyzEnterArguments

data class YieldXyzEnterArguments(val amount: String? = null, val validatorAddress: String? = null, val validatorAddresses: List<String>? = null, val providerId: String? = null, val duration: Int? = null, val inputToken: String? = null, val subnetId: Int? = null, val tronResource: YieldXyzTronResource? = null, val feeConfigurationId: String? = null, val cosmosPubKey: String? = null, val tezosPubKey: String? = null, val cAddressBech: String? = null, val pAddressBech: String? = null, val executionMode: YieldXyzExecutionMode? = null, val ledgerWalletApiCompatible: Boolean? = null)

Arguments for entering a yield opportunity

YieldXyzEnterRawResponse

data class YieldXyzEnterRawResponse(val id: String, val intent: YieldXyzActionIntent, val type: YieldXyzActionType, val yieldId: String, val address: String, val amount: String? = null, val amountRaw: String? = null, val amountUsd: String? = null, val transactions: List<YieldXyzActionTransaction>, val executionPattern: YieldXyzActionExecutionPattern, val rawArguments: YieldXyzEnterArguments? = null, val createdAt: String, val completedAt: String? = null, val status: YieldXyzActionStatus)

YieldXyzEnterRequest

data class YieldXyzEnterRequest(val yieldId: String, val address: String, val arguments: YieldXyzEnterArguments? = null)

Request to enter a yield opportunity

YieldXyzEnterYieldData

data class YieldXyzEnterYieldData(val rawResponse: YieldXyzEnterRawResponse)

YieldXyzEnterYieldResponse

data class YieldXyzEnterYieldResponse(val data: YieldXyzEnterYieldData? = null, val error: String? = null)

Response from entering a yield opportunity

YieldXyzEntryLimits

data class YieldXyzEntryLimits(val minimum: String? = null, val maximum: String? = null)

Entry limits information

YieldXyzExecutionMode

enum YieldXyzExecutionMode : Enum<YieldXyzExecutionMode>

Execution modes for yield actions

YieldXyzExitData

data class YieldXyzExitData(val rawResponse: YieldXyzExitRawResponse)

YieldXyzExitRawResponse

data class YieldXyzExitRawResponse(val id: String, val intent: YieldXyzActionIntent, val type: YieldXyzActionType, val yieldId: String, val address: String, val amount: String? = null, val amountRaw: String? = null, val amountUsd: String? = null, val transactions: List<YieldXyzActionTransaction>, val executionPattern: YieldXyzActionExecutionPattern, val rawArguments: YieldXyzEnterArguments? = null, val createdAt: String, val completedAt: String? = null, val status: YieldXyzActionStatus)

YieldXyzExitRequest

data class YieldXyzExitRequest(val yieldId: String, val address: String, val arguments: YieldXyzEnterArguments? = null)

Request to exit a yield opportunity

YieldXyzExitResponse

data class YieldXyzExitResponse(val data: YieldXyzExitData? = null, val error: String? = null)

Response from exiting a yield opportunity

YieldXyzFee

data class YieldXyzFee(val deposit: Double, val withdrawal: Double, val performance: Double, val management: Double)

Fee information

YieldXyzGetBalancesData

data class YieldXyzGetBalancesData(val rawResponse: YieldXyzGetBalancesRawResponse)

YieldXyzGetBalancesItem

data class YieldXyzGetBalancesItem(val yieldId: String, val balances: List<YieldXyzBalance>)

YieldXyzGetBalancesMetadata

data class YieldXyzGetBalancesMetadata(val clientId: String? = null)

YieldXyzGetBalancesRawResponse

data class YieldXyzGetBalancesRawResponse(val items: List<YieldXyzGetBalancesItem>, val errors: List<String> = emptyList())

YieldXyzGetBalancesRequest

data class YieldXyzGetBalancesRequest(val queries: List<YieldXyzBalanceQuery>)

Request to get yield balances for specific addresses and networks

YieldXyzGetBalancesResponse

data class YieldXyzGetBalancesResponse(val data: YieldXyzGetBalancesData? = null, val error: String? = null, val metadata: YieldXyzGetBalancesMetadata? = null)

Response from getting yield balances

YieldXyzGetHistoricalActionsData

data class YieldXyzGetHistoricalActionsData(val rawResponse: YieldXyzGetHistoricalActionsRawResponse)

YieldXyzGetHistoricalActionsRawResponse

data class YieldXyzGetHistoricalActionsRawResponse(val items: List<YieldXyzEnterRawResponse>, val total: Int? = null, val offset: Int? = null, val limit: Int? = null)

YieldXyzGetHistoricalActionsRequest

data class YieldXyzGetHistoricalActionsRequest(val offset: Int? = null, val limit: Int? = null, val address: String? = null, val status: YieldXyzActionStatus? = null, val intent: YieldXyzActionIntent? = null, val type: YieldXyzActionType? = null, val yieldId: String? = null)

Request to get historical yield actions with optional filtering

YieldXyzGetHistoricalActionsResponse

data class YieldXyzGetHistoricalActionsResponse(val data: YieldXyzGetHistoricalActionsData? = null, val error: String? = null, val metadata: YieldXyzGetBalancesMetadata? = null)

Response for fetching yield actions list for an address

YieldXyzGetTransactionData

data class YieldXyzGetTransactionData(val rawResponse: YieldXyzGetTransactionRawResponse)

YieldXyzGetTransactionMetadata

data class YieldXyzGetTransactionMetadata(val clientId: String? = null, val transactionId: String? = null)

YieldXyzGetTransactionRawResponse

data class YieldXyzGetTransactionRawResponse(val id: String, val title: String, val network: String, val status: YieldXyzActionTransactionStatus, val type: YieldXyzActionTransactionType, val hash: String? = null, val createdAt: String, val broadcastedAt: String? = null, val signedTransaction: String? = null, val unsignedTransaction: String? = null, val stepIndex: Int, val gasEstimate: String? = null)

Mirrors a single transaction object returned by the Yield.xyz actions API.

YieldXyzGetTransactionResponse

data class YieldXyzGetTransactionResponse(val data: YieldXyzGetTransactionData? = null, val error: String? = null, val metadata: YieldXyzGetTransactionMetadata? = null)

Response for fetching a single yield action transaction by ID

YieldXyzGetYieldsData

data class YieldXyzGetYieldsData(val rawResponse: YieldXyzGetYieldsRawResponse)

YieldXyzGetYieldsRawResponse

data class YieldXyzGetYieldsRawResponse(val items: List<YieldXyzOpportunity>, val limit: Int, val offset: Int, val total: Int)

YieldXyzGetYieldsRequest

data class YieldXyzGetYieldsRequest(val offset: Int? = null, val limit: Int? = null, val network: String? = null, val yieldId: String? = null, val type: YieldXyzMechanicsType? = null, val hasCooldownPeriod: Boolean? = null, val hasWarmupPeriod: Boolean? = null, val token: String? = null, val inputToken: String? = null, val provider: String? = null, val search: String? = null, val sort: YieldXyzGetYieldsSort? = null)

Request parameters for getting yield opportunities from Yield.xyz

YieldXyzGetYieldsResponse

data class YieldXyzGetYieldsResponse(val data: YieldXyzGetYieldsData? = null, val error: String? = null)

Response containing yield opportunities from Yield.xyz

YieldXyzGetYieldsSort

enum YieldXyzGetYieldsSort : Enum<YieldXyzGetYieldsSort>

Sort options for yield opportunities

YieldXyzLockupPeriod

data class YieldXyzLockupPeriod(val seconds: Long)

Lockup period information

YieldXyzManageYieldData

data class YieldXyzManageYieldData(val rawResponse: YieldXyzManageYieldRawResponse)

YieldXyzManageYieldRawResponse

data class YieldXyzManageYieldRawResponse(val id: String, val intent: YieldXyzActionIntent, val type: YieldXyzActionType, val yieldId: String, val address: String, val amount: String? = null, val amountRaw: String? = null, val amountUsd: String? = null, val transactions: List<YieldXyzActionTransaction>, val executionPattern: YieldXyzActionExecutionPattern, val rawArguments: YieldXyzEnterArguments? = null, val createdAt: String, val completedAt: String? = null, val status: YieldXyzActionStatus)

YieldXyzManageYieldRequest

data class YieldXyzManageYieldRequest(val yieldId: String, val address: String, val arguments: YieldXyzEnterArguments? = null, val action: YieldXyzActionType, val passthrough: String)

Request to manage a yield opportunity

YieldXyzManageYieldResponse

data class YieldXyzManageYieldResponse(val data: YieldXyzManageYieldData? = null, val error: String? = null)

Response from managing a yield opportunity

YieldXyzMechanics

data class YieldXyzMechanics(val type: YieldXyzMechanicsType, val requiresValidatorSelection: Boolean, val rewardSchedule: YieldXyzRewardSchedule, val rewardClaiming: YieldXyzRewardClaiming, val gasFeeToken: YieldXyzToken, val lockupPeriod: YieldXyzLockupPeriod? = null, val cooldownPeriod: YieldXyzCooldownPeriod? = null, val warmupPeriod: YieldXyzWarmupPeriod? = null, val fee: YieldXyzFee? = null, val entryLimits: YieldXyzEntryLimits, val supportsLedgerWalletApi: Boolean, val extraTransactionFormatsSupported: List<String>? = null, val arguments: YieldXyzArguments, val possibleFeeTakingMechanisms: YieldXyzPossibleFeeTakingMechanisms)

Mechanics information for a yield opportunity

YieldXyzMechanicsType

enum YieldXyzMechanicsType : Enum<YieldXyzMechanicsType>

Yield mechanics types

YieldXyzOpportunity

data class YieldXyzOpportunity(val id: String, val network: String, val inputTokens: List<YieldXyzToken>, val outputToken: YieldXyzToken, val token: YieldXyzToken, val rewardRate: YieldXyzRewardRate, val statistics: YieldXyzStatistics? = null, val status: YieldXyzStatus, val metadata: YieldXyzOpportunityMetadata, val mechanics: YieldXyzMechanics, val providerId: String, val tags: List<String>)

A yield opportunity

YieldXyzOpportunityMetadata

data class YieldXyzOpportunityMetadata(val name: String, val logoURI: String, val description: String, val documentation: String, val underMaintenance: Boolean, val deprecated: Boolean, val supportedStandards: List<String>)

Metadata for a yield opportunity

YieldXyzPossibleFeeTakingMechanisms

data class YieldXyzPossibleFeeTakingMechanisms(val depositFee: Boolean, val managementFee: Boolean, val performanceFee: Boolean, val validatorRebates: Boolean)

Possible fee taking mechanisms

YieldXyzRateType

enum YieldXyzRateType : Enum<YieldXyzRateType>

Rate type enum

YieldXyzRewardClaiming

enum YieldXyzRewardClaiming : Enum<YieldXyzRewardClaiming>

Reward claiming enum

YieldXyzRewardRate

data class YieldXyzRewardRate(val total: Double, val rateType: YieldXyzRateType, val components: List<YieldXyzRewardRateComponent>)

Reward rate information

YieldXyzRewardRateComponent

data class YieldXyzRewardRateComponent(val rate: Double, val rateType: YieldXyzRateType, val token: YieldXyzToken, val yieldSource: YieldXyzSource, val description: String)

Reward rate component

YieldXyzRewardSchedule

enum YieldXyzRewardSchedule : Enum<YieldXyzRewardSchedule>

Reward schedule enum

YieldXyzSource

enum YieldXyzSource : Enum<YieldXyzSource>

Yield source enum

YieldXyzStatistics

data class YieldXyzStatistics(val tvlUsd: String? = null, val tvl: Double? = null, val uniqueUsers: Int? = null, val averagePositionSizeUsd: Double? = null, val averagePositionSize: Double? = null)

Statistics for a yield opportunity

YieldXyzStatus

data class YieldXyzStatus(val enter: Boolean, val exit: Boolean)

Status of a yield opportunity

YieldXyzToken

data class YieldXyzToken(val symbol: String, val name: String, val decimals: Int? = null, val network: String? = null, val address: String? = null, val logoURI: String? = null, val isPoints: Boolean? = null, val coinGeckoId: String? = null)

Token information

YieldXyzTrackTransactionData

data class YieldXyzTrackTransactionData(val rawResponse: YieldXyzTrackTransactionRawResponse)

YieldXyzTrackTransactionRawResponse

data class YieldXyzTrackTransactionRawResponse(val id: String, val title: String, val network: String, val status: YieldXyzActionTransactionStatus, val type: YieldXyzActionTransactionType, val hash: String? = null, val createdAt: String, val broadcastedAt: String? = null, val signedTransaction: String? = null, val unsignedTransaction: String? = null, val stepIndex: Int, val gasEstimate: String? = null)

YieldXyzTrackTransactionRequest

data class YieldXyzTrackTransactionRequest(val transactionId: String, val hash: String)

Request to submit a transaction hash for tracking

YieldXyzTrackTransactionResponse

data class YieldXyzTrackTransactionResponse(val data: YieldXyzTrackTransactionData? = null, val error: String? = null)

Response from submitting a transaction hash

YieldXyzTronResource

enum YieldXyzTronResource : Enum<YieldXyzTronResource>

Tron resource types

YieldXyzWarmupPeriod

data class YieldXyzWarmupPeriod(val seconds: Long)

Warmup period information